Clears the contents of the scrap.

OSStatus ZeroScrap ();

function result

A result code.

DISCUSSION

If the scrap does not already exist (in memory or on the disk), the function initializes the scrap in memory. Whenever your application needs to write data to the scrap as a result of a cut or copy operation by the user, you should call this function before calling the PutScrap function. If your application needs to write data in one or more formats to the scrap, you should call this function before the first time you call PutScrap.

If your application uses the TEToScrap function to write TextEdit’s scrap to the scrap, your application should call this function to clear the contents of the scrap first. However, note that your application does not have to call this function before calling the TECut function or the TECopy function.

SPECIAL CONSIDERATIONS

Because this function may move or purge memory blocks or access handles, your application should not call it at interrupt time.

AVAILABILITY

Not supported in Carbon. Not available in CarbonLib, but available when InterfaceLib 7.1 or later is installed. Exported by InterfaceLib 7.1 and later.

CARBON NOTES

You should instead use the function ClearCurrentScrap.

© 2000 Apple Computer, Inc. — (Last Updated 4/4/2000)